Skip to main content

๐Ÿ”„ Request Action

The Request Action is used to handle incoming HTTP requests and trigger a workflow based on the request parameters. It allows detailed control over request structure, authentication, headers, and expected responses.

This action is essential for workflows that need to interact with external services, APIs, or frontend applications.

๐Ÿงฉ Configuration Overviewโ€‹

The Request Action configuration dialog is divided into several tabs to control every aspect of the HTTP request:

1. Request Basic Infoโ€‹

  • Method: Select from GET, POST, PUT, DELETE, etc.
  • Name: Provide a unique name for the request (required).
  • Group: Assign this request to a group/category (required).

2. Params Tabโ€‹

Configure the parameters your HTTP request can accept:

๐Ÿงท Query Paramsโ€‹

KeyValueDescription
Define URL parameters to be passed as part of the request.

๐Ÿ”— Path Variablesโ€‹

KeyValueDescription
Useful for dynamic routing like /user/:id.

3. Authorization Tabโ€‹

Specify how the request should be authenticated:

  • No Auth โ€“ No authentication required.
  • API Key โ€“ Send a static key in headers or query params.
  • Bearer Token โ€“ Secure access using bearer tokens (commonly used in OAuth2).
  • Basic Auth โ€“ Username/password authentication.

Example:

Type: Bearer Token
Token: abc123xyz

4. Headers Tabโ€‹

Use headers to add metadata or required configurations to your request:

KeyValueDescription
Content-Typeapplication/jsonSpecifies body type
AuthorizationBearer abc123API token

5. Body Tabโ€‹

Define the body of the request depending on its type:

  • None โ€“ No body required (e.g., for GET requests).
  • Form-Data โ€“ Key/value pairs for forms.
  • Raw โ€“ Send raw JSON, XML, or text.
  • Files โ€“ Send file uploads.

Example: Raw JSON Bodyโ€‹

{
"username": "john_doe",
"email": "john@example.com"
}

6. Response JSON Tabโ€‹

Configure how the workflow should respond after execution.

  • Status Code โ€“ Define expected HTTP response codes (e.g., 200, 404).
  • Response JSON โ€“ Define the JSON structure to be returned with each status.

Example:โ€‹

  • 200 OK โ€“ Returns:
{ "status": "success" }

โœ… Use Casesโ€‹

  • Trigger workflows from third-party webhooks.
  • Build REST endpoints for your automation logic.
  • Accept dynamic form submissions and process them in real-time.
  • Secure incoming requests using authentication mechanisms.

๐Ÿ“Œ Summaryโ€‹

The Request Action forms the entry point of any externally triggered workflow. With support for parameters, authentication, flexible body types, and structured responses, it empowers seamless integration with outside systems or clients.

Use this action to build responsive, secure, and structured API-driven workflows.